﻿// -----------------------------------------------------------------------
// <copyright company="www.3WayWebdesign.de">
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
// 
// <author>Michael Morbach</author>
// <email>Michael@3waywebdesign.de</email>
// <web>http://www.3waywebdesign.de</web>
// ----------------------------------------------------------------------

using System.Windows;
using System.Windows.Media;

namespace Tww.MAF.MAFControlSuite.Controls.Attached
{
    public class HighlightEffects : DependencyObject
    {
        #region  - Felder (öffentlich) -

        /// <summary>
        /// Define a Color to visualize a highlight effect
        /// </summary>
        public static readonly DependencyProperty HighlightColorProperty =
            DependencyProperty.Register("HighlightColor", typeof (Color), typeof (HighlightEffects),
                new UIPropertyMetadata(null));

        /// <summary>
        /// Determines whether the highlight effect should be visible or not
        /// </summary>
        public static readonly DependencyProperty HighlightVisibilityProperty =
            DependencyProperty.Register("HighlightVisibility", typeof (Visibility), typeof (HighlightEffects),
                new UIPropertyMetadata(Visibility.Visible));

        #endregion

        #region  - Methoden (öffentlich) -

        /// <summary>
        /// Sets the highlight visibility.
        /// </summary>
        /// <param name="element">The element.</param>
        /// <param name="value">The value.</param>
        public static void SetHighlightVisibility(UIElement element, Visibility value)
        {
            element.SetValue(HighlightVisibilityProperty, value);
        }


        /// <summary>
        /// Gets the highlight visibility.
        /// </summary>
        /// <param name="element">The element.</param>
        /// <returns></returns>
        public static Visibility GetHighlightVisibility(UIElement element)
        {
            return (Visibility) element.GetValue(HighlightVisibilityProperty);
        }


        /// <summary>
        /// Sets the color of the h highlight.
        /// </summary>
        /// <param name="element">The element.</param>
        /// <param name="value">The value.</param>
        public static void SetHighlightColor(UIElement element, Color value)
        {
            element.SetValue(HighlightColorProperty, value);
        }

        /// <summary>
        /// Gets the color of the highlight.
        /// </summary>
        /// <param name="element">The element.</param>
        /// <returns></returns>
        public static Color GetHighlightColor(UIElement element)
        {
            return (Color) element.GetValue(HighlightColorProperty);
        }

        #endregion
    }
}